<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta content="width=device-width, initial-scale=1.0" name="viewport">
    <meta content="smart-doc" name="generator">
    <title>mail-boot</title>
    <link href="font.css" rel="stylesheet">
    <link href="AllInOne.css?v=1665239542406" rel="stylesheet"/>
    <style>.literalblock pre, .listingblock pre:not(.highlight), .listingblock pre[class="highlight"], .listingblock pre[class^="highlight "], .listingblock pre.CodeRay, .listingblock pre.prettyprint {
        background: #f7f7f8
    }

    .hljs {
        padding: 0
    }</style>
    <script src="highlight.min.js"></script>
    <script src="jquery.min.js"></script>
</head>
<body class="book toc2 toc-left">
<div id="header"><h1>mail-boot</h1>
    <div class="toc2" id="toc">
        <div id="book-search-input"><input id="search" placeholder="Type to search" type="text"></div>
        <div id="toctitle"><span>API Reference</span></div>
        <ul class="sectlevel1" id="accordion">            <li class="open"><a class="dd" href="#_邮件消息发送表">2.邮件消息发送表</a>
                <ul class="sectlevel2">
                    <li><a
                            href="#_1_2_1_预警邮件">2.1.预警邮件</a>
                    </li>

                    <li><a
                            href="#_1_2_2_发送单个邮件服务可以自定义标题以及内容">2.2.发送单个邮件服务可以自定义标题以及内容</a>
                    </li>

                    <li><a
                            href="#_1_2_3_发送验证码">2.3.发送验证码</a>
                    </li>

                    <li><a
                            href="#_1_2_4_发送html邮件">2.4.发送html邮件</a>
                    </li>
                </ul>
            </li>
            <li class="open"><a class="dd" href="#_邮件消息模板表">1.邮件消息模板表</a>
                <ul class="sectlevel2">                </ul>
            </li>
        </ul>
    </div>
</div>
<div id="content">
    <div id="preamble">
        <div class="sectionbody">
            <table class="tableblock frame-all grid-all spread">
                <colgroup>
                    <col style="width: 20%;">
                    <col style="width: 20%;">
                    <col style="width: 20%;">
                    <col style="width: 20%;">
                    <col style="width: 20%;">
                </colgroup>
                <thead>
                <tr>
                    <th class="tableblock halign-left valign-top">Version</th>
                    <th class="tableblock halign-left valign-top">Update Time</th>
                    <th class="tableblock halign-left valign-top">Status</th>
                    <th class="tableblock halign-left valign-top">Author</th>
                    <th class="tableblock halign-left valign-top">Description</th>
                </tr>
                </thead>
                <tbody>
                <tr>
                    <td class="tableblock halign-left valign-top"><p class="tableblock">v2022-10-08 22:32:22</p></td>
                    <td class="tableblock halign-left valign-top"><p class="tableblock">2022-10-08 22:32:22</p>
                    </td>
                    <td class="tableblock halign-left valign-top"><p class="tableblock">auto</p></td>
                    <td class="tableblock halign-left valign-top"><p class="tableblock">@mazaiting</p></td>
                    <td class="tableblock halign-left valign-top"><p class="tableblock">Created by smart-doc</p></td>
                </tr>
                </tbody>
            </table>
        </div>
    </div>
    
    <div class="sect1"><h2 id="_邮件消息发送表"><a class="anchor" href="#_邮件消息发送表"></a><a class="link"
                                                                                           href="#_邮件消息发送表">2.邮件消息发送表</a>
    </h2>
        <div class="sectionbody">
            <div class="sect2" id="0bbc22b1be038950bea427f958ef8ee8"><h3 id="_1_2_1_预警邮件"><a
                    class="anchor" href="#_1_2_1_预警邮件"></a><a class="link"
                                                                                        href="#_1_2_1_预警邮件">2.1.预警邮件</a>
            </h3>
                <div class="paragraph" data-download="false" data-page="" data-url="/mail/v1/send/alarm"
                     id="0bbc22b1be038950bea427f958ef8ee8-url"><p><strong>URL:</strong><a class="bare"
                                                                         href="/mail/v1/send/alarm">/mail/v1/send/alarm</a></p>
                </div>
                <div class="paragraph" data-method="POST" id="0bbc22b1be038950bea427f958ef8ee8-method"><p><strong>Type:</strong>POST
                </p></div>
                <div class="paragraph"><p><strong>Author:</strong>mazaiting</p></div>
                <div class="paragraph" data-content-type="application/x-www-form-urlencoded;charset=utf-8" id="0bbc22b1be038950bea427f958ef8ee8-content-type"><p>
                    <strong>Content-Type:</strong>application/x-www-form-urlencoded;charset=utf-8</p></div>
                <div class="paragraph"><p><strong>Description:</strong>预警邮件</p></div>
                <div class="paragraph"><p><strong>Query-parameters:</strong></p></div>
                <table class="tableblock frame-all grid-all spread">
                    <colgroup>
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                    </colgroup>
                    <thead>
                    <tr>
                        <th class="tableblock halign-left valign-top">Parameter</th>
                        <th class="tableblock halign-left valign-top">Type</th>
                        <th class="tableblock halign-left valign-top">Description</th>
                        <th class="tableblock halign-left valign-top">Required</th>
                        <th class="tableblock halign-left valign-top">Since</th>
                    </tr>
                    </thead>
                    <tbody>
                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">mailId</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">int64</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            邮件 ID</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">platform</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            平台</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">receiver</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            邮件接收者</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">cc</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            抄送人</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">title</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            邮件标题</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            邮件内容</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">html</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            是否为 html</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">attachments</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">array</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            附件, 文件 ID 列表</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>
                    </tbody>
                </table>
                <div class="paragraph"><p><strong>Request-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="bash">curl -X POST -i /mail/v1/send/alarm</code></pre>
                    </div>
                </div>
                <div class="paragraph"><p><strong>Response-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="json">true</code></pre>
                    </div>
                </div>
            </div>

            <div class="sect2" id="3c8a5c4404a3343996be09d95e94b1c7"><h3 id="_1_2_2_发送单个邮件服务可以自定义标题以及内容"><a
                    class="anchor" href="#_1_2_2_发送单个邮件服务可以自定义标题以及内容"></a><a class="link"
                                                                                        href="#_1_2_2_发送单个邮件服务可以自定义标题以及内容">2.2.发送单个邮件服务可以自定义标题以及内容</a>
            </h3>
                <div class="paragraph" data-download="false" data-page="" data-url="/mail/v1/send/send"
                     id="3c8a5c4404a3343996be09d95e94b1c7-url"><p><strong>URL:</strong><a class="bare"
                                                                         href="/mail/v1/send/send">/mail/v1/send/send</a></p>
                </div>
                <div class="paragraph" data-method="POST" id="3c8a5c4404a3343996be09d95e94b1c7-method"><p><strong>Type:</strong>POST
                </p></div>
                <div class="paragraph"><p><strong>Author:</strong>mazaiting</p></div>
                <div class="paragraph" data-content-type="application/x-www-form-urlencoded;charset=utf-8" id="3c8a5c4404a3343996be09d95e94b1c7-content-type"><p>
                    <strong>Content-Type:</strong>application/x-www-form-urlencoded;charset=utf-8</p></div>
                <div class="paragraph"><p><strong>Description:</strong>发送单个邮件服务
可以自定义标题以及内容</p></div>
                <div class="paragraph"><p><strong>Request-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="bash">curl -X POST -i /mail/v1/send/send</code></pre>
                    </div>
                </div>
                <div class="paragraph"><p><strong>Response-fields:</strong></p></div>
                <table class="tableblock frame-all grid-all spread">
                    <colgroup>
                        <col style="width: 25%;">
                        <col style="width: 25%;">
                        <col style="width: 25%;">
                        <col style="width: 25%;">
                    </colgroup>
                    <thead>
                    <tr>
                        <th class="tableblock halign-left valign-top">Field</th>
                        <th class="tableblock halign-left valign-top">Type</th>
                        <th class="tableblock halign-left valign-top">Description</th>
                        <th class="tableblock halign-left valign-top">Since</th>
                    </tr>
                    </thead>
                    <tbody>
                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">code</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            码值</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">msg</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            消息</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">data</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            数据</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>
                    </tbody>
                </table>
                <div class="paragraph"><p><strong>Response-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="json">{
  "code": 169,
  "msg": "q4kh0b",
  "data": "cnm7cx"
}</code></pre>
                    </div>
                </div>
            </div>

            <div class="sect2" id="e95f73139fe7cf4f5a422886b455a86f"><h3 id="_1_2_3_发送验证码"><a
                    class="anchor" href="#_1_2_3_发送验证码"></a><a class="link"
                                                                                        href="#_1_2_3_发送验证码">2.3.发送验证码</a>
            </h3>
                <div class="paragraph" data-download="false" data-page="" data-url="/mail/v1/send/sendCode"
                     id="e95f73139fe7cf4f5a422886b455a86f-url"><p><strong>URL:</strong><a class="bare"
                                                                         href="/mail/v1/send/sendCode">/mail/v1/send/sendCode</a></p>
                </div>
                <div class="paragraph" data-method="POST" id="e95f73139fe7cf4f5a422886b455a86f-method"><p><strong>Type:</strong>POST
                </p></div>
                <div class="paragraph"><p><strong>Author:</strong>mazaiting</p></div>
                <div class="paragraph" data-content-type="application/x-www-form-urlencoded;charset=utf-8" id="e95f73139fe7cf4f5a422886b455a86f-content-type"><p>
                    <strong>Content-Type:</strong>application/x-www-form-urlencoded;charset=utf-8</p></div>
                <div class="paragraph"><p><strong>Description:</strong>发送验证码</p></div>
                <div class="paragraph"><p><strong>Query-parameters:</strong></p></div>
                <table class="tableblock frame-all grid-all spread">
                    <colgroup>
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                    </colgroup>
                    <thead>
                    <tr>
                        <th class="tableblock halign-left valign-top">Parameter</th>
                        <th class="tableblock halign-left valign-top">Type</th>
                        <th class="tableblock halign-left valign-top">Description</th>
                        <th class="tableblock halign-left valign-top">Required</th>
                        <th class="tableblock halign-left valign-top">Since</th>
                    </tr>
                    </thead>
                    <tbody>
                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">to</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            接受者</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">code</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            验证码</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>
                    </tbody>
                </table>
                <div class="paragraph"><p><strong>Request-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="bash">curl -X POST -i /mail/v1/send/sendCode</code></pre>
                    </div>
                </div>
                <div class="paragraph"><p><strong>Response-fields:</strong></p></div>
                <table class="tableblock frame-all grid-all spread">
                    <colgroup>
                        <col style="width: 25%;">
                        <col style="width: 25%;">
                        <col style="width: 25%;">
                        <col style="width: 25%;">
                    </colgroup>
                    <thead>
                    <tr>
                        <th class="tableblock halign-left valign-top">Field</th>
                        <th class="tableblock halign-left valign-top">Type</th>
                        <th class="tableblock halign-left valign-top">Description</th>
                        <th class="tableblock halign-left valign-top">Since</th>
                    </tr>
                    </thead>
                    <tbody>
                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">code</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            码值</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">msg</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            消息</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">data</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            数据</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>
                    </tbody>
                </table>
                <div class="paragraph"><p><strong>Response-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="json">{
  "code": 438,
  "msg": "tew74v",
  "data": "errvgk"
}</code></pre>
                    </div>
                </div>
            </div>

            <div class="sect2" id="cf6eab732d02cab4ff15d90f573cdf82"><h3 id="_1_2_4_发送html邮件"><a
                    class="anchor" href="#_1_2_4_发送html邮件"></a><a class="link"
                                                                                        href="#_1_2_4_发送html邮件">2.4.发送html邮件</a>
            </h3>
                <div class="paragraph" data-download="false" data-page="" data-url="/mail/v1/send/sendHtmlMail"
                     id="cf6eab732d02cab4ff15d90f573cdf82-url"><p><strong>URL:</strong><a class="bare"
                                                                         href="/mail/v1/send/sendHtmlMail">/mail/v1/send/sendHtmlMail</a></p>
                </div>
                <div class="paragraph" data-method="POST" id="cf6eab732d02cab4ff15d90f573cdf82-method"><p><strong>Type:</strong>POST
                </p></div>
                <div class="paragraph"><p><strong>Author:</strong>mazaiting</p></div>
                <div class="paragraph" data-content-type="application/x-www-form-urlencoded;charset=utf-8" id="cf6eab732d02cab4ff15d90f573cdf82-content-type"><p>
                    <strong>Content-Type:</strong>application/x-www-form-urlencoded;charset=utf-8</p></div>
                <div class="paragraph"><p><strong>Description:</strong>发送html邮件</p></div>
                <div class="paragraph"><p><strong>Request-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="bash">curl -X POST -i /mail/v1/send/sendHtmlMail</code></pre>
                    </div>
                </div>
                <div class="paragraph"><p><strong>Response-fields:</strong></p></div>
                <table class="tableblock frame-all grid-all spread">
                    <colgroup>
                        <col style="width: 25%;">
                        <col style="width: 25%;">
                        <col style="width: 25%;">
                        <col style="width: 25%;">
                    </colgroup>
                    <thead>
                    <tr>
                        <th class="tableblock halign-left valign-top">Field</th>
                        <th class="tableblock halign-left valign-top">Type</th>
                        <th class="tableblock halign-left valign-top">Description</th>
                        <th class="tableblock halign-left valign-top">Since</th>
                    </tr>
                    </thead>
                    <tbody>
                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">code</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">int32</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            码值</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">msg</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            消息</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">data</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            数据</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>
                    </tbody>
                </table>
                <div class="paragraph"><p><strong>Response-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="json">{
  "code": 46,
  "msg": "0xo8gq",
  "data": "yh70xg"
}</code></pre>
                    </div>
                </div>
            </div>
        </div>
    </div>

    <div class="sect1"><h2 id="_邮件消息模板表"><a class="anchor" href="#_邮件消息模板表"></a><a class="link"
                                                                                           href="#_邮件消息模板表">1.邮件消息模板表</a>
    </h2>
        <div class="sectionbody">        </div>
    </div>
    <footer class="page-footer"><span class="copyright">Generated by smart-doc at 2022-10-08 22:32:22</span><span
            class="footer-modification">Suggestions,contact,support and error reporting on<a
            href="https://gitee.com/smart-doc-team/smart-doc" target="_blank">Gitee</a>or<a
            href="https://github.com/smart-doc-group/smart-doc.git" target="_blank">Github</a></span>
    </footer>
    <div href="javascript:void(0)" id="toTop"><img id="upArrow"
                                                   src=""><span
            id="upText">Top</span></div>
</div>
<script src="search.js?v=1665239542406"></script>
<script>
    $(function(){const Accordion=function(el,multiple){this.el=el||{};this.multiple=multiple||false;const links=this.el.find(".dd");links.on("click",{el:this.el,multiple:this.multiple},this.dropdown)};Accordion.prototype.dropdown=function(e){const $el=e.data.el;const $this=$(this),$next=$this.next();$next.slideToggle();$this.parent().toggleClass("open");if(!e.data.multiple){$el.find(".submenu").not($next).slideUp("20").parent().removeClass("open")}};new Accordion($("#accordion"),false);hljs.highlightAll();$(window).scroll(function(){if($(window).scrollTop()>100){$("#toTop").fadeIn(1500);$("#toTop").hover(function(){$("#upArrow").hide();$("#upText").show()},function(){$("#upArrow").show();$("#upText").hide()})}else{$("#toTop").fadeOut(1500)}});$("#toTop").click(function(){$("body, html").animate({scrollTop:0},1000);return false})});










</script>
</body>
</html>